home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / dman_300.zip / DMGRAPH.DOC < prev    next >
Text File  |  1992-11-15  |  11KB  |  253 lines
  1.  
  2.  
  3.                        DoorMan Stats Grapher v3.00
  4.                               Documentation
  5.  
  6.                   ┌───────────────────────────────────┐
  7.                   │                                   │
  8.                   │      !! DESQView Users !!!        │
  9.                   │                                   │
  10.                   │ This program uses direct screen   │
  11.                   │ writes!  Make sure to tell DV     │
  12.                   │ when you set up a window for it.  │
  13.                   │ Under DV 2.41, the program will   │
  14.                   │ run fine in a 256k window.        │
  15.                   │                                   │
  16.                   │ If you're running Wildcat, DO     │
  17.                   │ NOT attempt to shell from Wildcat │
  18.                   │ to this program!  It WILL cause   │
  19.                   │ problems.  Simply open another    │
  20.                   │ window for it.                    │
  21.                   │                                   │
  22.                   └───────────────────────────────────┘
  23.  
  24. OVERVIEW
  25.  
  26. DoorStat is a companion program to DoorMan.  It is a utility to
  27. read the DOORMAN.DAT file created by DoorMan and create Bar
  28. Graphs based on the door usage data contained in it.  Graphs can
  29. be created and viewed in three different ways.  First, users can
  30. choose Graphs from within the door.  This will allow them to
  31. define and view as many graphs they want.  Second, from the
  32. Config Editor, which is built into the program, you can create
  33. and view graphs.  Lastly, the program can be run during nightly
  34. maintenance to create/update up to 10 pre-defined graphs by
  35. calling it with the config file.  The program will create graphs
  36. in ANSI, ASCII, and WildCat! 3.0 formats.
  37.  
  38.  
  39. REQUIREMENTS
  40.  
  41. The program requires that it be placed in the same directory as
  42. DoorMan so it may access the DoorMan data files. 
  43.  
  44. It also requires that a DOORMAN.DAT file be present.  This file
  45. is created by DoorMan once a door is used.  You, or a user, must
  46. go into a door through DoorMan and stay there for AT LEAST one
  47. minute before the file will be created.  If you log on locally as
  48. yourself, you must also make sure that you have the door your 
  49. going into set up to record Sysop Stats in DoorEdit.
  50.  
  51.  
  52. SETUP
  53.  
  54. The first time you run DoorStat, you will be prompted for three
  55. defaults.  The program will only ask for these once, but you may
  56. always change them from the Config File Editor.  These defaults
  57. are as follows:
  58.  
  59.      Directory:  This is the full path to your bulletins
  60.                  directory. If the program is run with the
  61.                  config file, this is where it is going to put
  62.                  the graphs it creates.
  63.  
  64.      Default ANSI Extension:  The default extension to put on
  65.                               ANSI bulletins.
  66.  
  67.      Default ASCII Extension:  The default extension to put on
  68.                                ASCII bulletins.
  69.  
  70.      Note:  If you are running a WildCat! 3.0 system and choose
  71.             to create WildCat! 3.0 bulletins, then the last two
  72.             defaults don't mean anything.  Anytime the program is
  73.             instructed to create a WildCat! 3.0 bulletin, it uses
  74.             .BBS as the extension.
  75.  
  76.  
  77. Once you have defined these defaults, you will be given the
  78. Config File Edit Menu.
  79.  
  80. CONFIG FILE EDIT MENU OPTIONS
  81.  
  82. The Config File Editor serves two purposes.  First and foremost,
  83. it is where you define the "pre-defined" bulletins to be created
  84. during maintenance each night.  However, by using the preview
  85. option, it can also be used to experiment and to look at
  86. statistics you may not want to use in your bulletins.  No matter
  87. which purpose you want to use it for, the same menu options
  88. apply.  Following are there descriptions.
  89.  
  90. VIEW CURRENT CONFIG
  91.  
  92. This option is pretty self-explanatory.  When you choose it, you
  93. are given the defaults you have defined in a box, and the list of
  94. bulletins you have defined in the config file.
  95.  
  96. CHANGE DEFAULTS
  97.  
  98. Again, this one is pretty self-explanatory
  99.  
  100. ADD BULLETIN
  101.  
  102. This is the option you will undoubtedly use the most.  This is
  103. where you define the bulletins you want to preview and select the
  104. ones you want to add to the config file.  When you select this
  105. option, the first thing you have to do is select a subject for
  106. the bulletin.  Below are your choices and an explanation of each:
  107.  
  108.      Category:  This will allow you to graph the activity of one
  109.                 category over time, or, to create a graph
  110.                 comparing the activity of ALL categories.  When
  111.                 you choose this option, you will be asked whether
  112.                 you want One category or All.  If you choose one,
  113.                 then you will asked to choose which category
  114.                 from a list.
  115.  
  116.      Door:  This will allow you to graph the activity of one door
  117.             over time, or, to compare the activity of ALL doors
  118.             in one category.  When you choose this option, the
  119.             first thing you will be asked to do is to choose the
  120.             category the door(s) you want is/are in.  Once you
  121.             have chosen a category from the list, you will be 
  122.             prompted whether to use One door or All.  If you
  123.             choose one, you will be shown the list of doors in
  124.             that category and asked to choose one.
  125.  
  126.      Summary:  This option allows you to graph the activity of
  127.                ALL doors over time.
  128.  
  129. Once you have chosen a subject for the graph, you must then
  130. decide on what basis you want to compare/list the data.  Your
  131. choices are as follows:
  132.  
  133.      Times Used:  This will graph the activity of the subject
  134.                   based on the number of times it was used.
  135.  
  136.      Time in Door:  This will graph the activity of the subject
  137.                     based on the minutes of BBS time used.
  138.  
  139.  
  140. OK, now that we have a subject and know what data to use, the
  141. next step is to decide how much data to use.  In other words,
  142. define the scope of the bulletin.  Your choices:
  143.  
  144.      Day:  Graphs the activity of the subject over one day broken
  145.            down hour.  This is handy for finding out when the
  146.            best/worst time to call the BBS is if you want to play
  147.            a game.  Once you have chosen this option, you will be
  148.            asked which day to display.  You may choose any single
  149.            day during the month, -1 for yesterday's activity, 0 
  150.            for today's activity, or A for ALL days activity.   No
  151.            
  152.      Month:  Graphs the activity of the subject for a given month
  153.              broken down by day.  Once you choose this option,
  154.              you will be prompted for the month.  Simply enter
  155.              the 3 letter abbreviation, or Cur for this month.
  156.              On my system, this graph revealed a weekly cycle in
  157.              door usage.  It may help your users better decide 
  158.              what day to call during the week.
  159.  
  160.      Total:  Graphs the activity of the subject over the total
  161.              history available broken down by day.  This is
  162.              limited to 60 days due to the size of the screen. 
  163.              If there are more than 60 days of data present, the
  164.              program will get the data for the most recent 60
  165.              days.  In other words, the graph will always
  166.              start with yesterday and go backwards up to 60 days.
  167.  
  168. Next, you will be prompted for a node number.  This will allow
  169. you to look at door usage on individual nodes, or All nodes.
  170.  
  171. Lastly, you will be prompted for the Security Level to use when
  172. creating the graph.  When a user creates a graph within the door,
  173. their security level is used.  However, when you create a graph
  174. to be used for a bulletin, DoorStat has no way of knowing what
  175. users will be viewing it.  Therefore, you tell it what to do
  176. here.  The result will be the same as a user with this security
  177. level creating a graph within the door.  Then, you can decide
  178. which users to show the bulletin to.
  179.  
  180. OK, now we have all the data needed to create the graph.  At this
  181. point, the program will as you if you want to preview the graph. 
  182. Say yes, and the program will go gather the data, create the
  183. graph, and then show it to you.  Once you're finished looking at
  184. it, the program will ask you whether or not to add the bulletin
  185. to the config file.
  186.  
  187. If you say Yes, then you will be prompted for the following Info:
  188.  
  189.      FileName:  This is the filename the program will use when
  190.                 creating the bulletin.  There is no need to put a
  191.                 path or an  extension since these are defined in
  192.                 the defaults.  The filename can be any valid DOS
  193.                 filename.
  194.  
  195.      Type: This can be ANSI, ASCII, Both, or WildCat! 3.0.  Which
  196.            type you choose decides what type file(s) are created
  197.            when the program runs during maintenance.
  198.  
  199.  
  200. REMOVE BULLETIN
  201.  
  202. Self explanatory.  However, there is a "Hidden" feature.  While
  203. experimenting/testing/playing with the program, I found that I
  204. kept adding a bunch of bulletins to the config file.  I would end
  205. up adding 10 bulletins, hitting the max, and not being able to
  206. play anymore.  So, I added a command to remove ALL the bulletins
  207. in the file.  When you are prompted which bulletin to remove,
  208. simply enter A (not a) and Poof! all of them are gone!
  209.  
  210. QUIT
  211.  
  212. Hmmm?  Wonder what that does?
  213.  
  214. Well, that about covers what the program does when run without a
  215. config file.  Now, for what it does with one.  After you've
  216. created one, you can call the program with it on the command line
  217. like so:
  218.  
  219.      DMGRAPH DMGRAPH.CFG
  220.  
  221. This will cause the program to automatically create the bulletins
  222. you have defined.  This is what you would do if you want to use
  223. the program in nightly maintenance.  What use is that if users
  224. can create their own bulletins, you ask?  Well, even though users
  225. have that option, I have found that there are still some people
  226. out there who will go to the bulletins menu and look at the
  227. graphs but won't go into Graphs from the door.  This option is
  228. for those people.  Also, it comes in handy for people who don't
  229. play games at all but are interested in how the BBS is being
  230. used.  
  231.  
  232. REGISTRATION INFORMATION
  233.  
  234. DMGraph is provided as an optional program with the DoorMan
  235. package.  No since making you pay a higher price for the package
  236. if you don't want to make graphs.  For this reason, it has its
  237. own key and registration fee.  Also, by doing it this way, you
  238. can come back at some future date and register the utility.  The
  239. price of the utility alone is $20.  However, if you register both
  240. programs at once, you get the utility for $10.  This only applies
  241. if both programs are registered at the SAME time!  If you
  242. register DoorMan, then come back a day later and want to register
  243. DMGraph, it will cost $20!  Once you register, you will get a
  244. non-expiring key which will be good for this and all future
  245. versions of the program.
  246.  
  247. SUGGESTIONS?
  248.  
  249. As with all my programs, I feel that the end user should have the
  250. final say in how a program operates.  Therefore, if you don't
  251. like something in the program or would like to see something
  252. added, feel free to send me a suggestion!  I will attempt to
  253. implement any suggestion I get!